home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / gt_power / emt110.zip / EMT.DOC next >
Text File  |  1991-01-02  |  20KB  |  482 lines
  1.  
  2.  
  3. EchoMail Tracker - version 1.10                             Documentation
  4. December 31, 1990
  5.  
  6.  
  7.  
  8.                                       EMT
  9.                                  by Blane M. Amy
  10.                               The Philosopher's Corner
  11.                               GT NET/NODE: 087/001
  12.                               BBS: (904) 472-1860
  13.                               Voice: (904) 472-6072
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21. Revisions:
  22. Version  Release Date  Comments
  23. -------  ------------- --------------------------------------
  24. 1.0 Beta July 11,1990    Not for distribution. Beta Test Only.
  25. 1.01Beta N/A             NOT RELEASED
  26.                        1-Made code more easily readable.
  27. 1.02Beta July 15,1990    Not for distribution. Beta Test Only.
  28.                        1-Fixed bug with reading Echolist.bbs. (Dennis Ivy)
  29. 1.03Beta July 16,1990    Not for distribution. Beta Test Only.
  30.                        1-Added: /B: option  (Jerry Havnar)
  31.                        2-Added: Retired, Renumbered, Down Echo Recognition.
  32.                        3-Re-wrote docs properly.
  33.                        4-Changed name of Error log EMTERR.LOG
  34. 1.04Beta July 23,1990    Not for distribution. Beta Test Only.
  35.                        1-Time date comaparison problem fixed. (Jerry Havnar)
  36. 1.05Beta July 25,1990    Not for distribution. Beta Test Only.
  37.                        1-Fixed problem - deleting consecutive echos no
  38.                          longer carried. (Discovered when Louis
  39.                          Moritzky's echos were all retired).
  40.                          Fixed problem with lower case letters in
  41.                          Routing.bbs file. (Richard Snow)
  42. 1.10     Dec. 31 1990  1-EMT.BBS file now written in .BBS directory (default).
  43.                        2-EMTERR.LOG file now written in .LOG directory.
  44.                        3-EMTERR.LOG no longer appended too, written each run.
  45.                        4-Year turnover fixed.  Program will now run unlimited
  46.                          time. (Roy Salisbury)
  47.                        5-File inclusion now supported. (Mark Street)
  48.                        6-Ranges in Echo ACCEPT statements supported.
  49.                        7-F files checked also.
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.                                       i
  61.  
  62.  
  63. Legal Notice
  64. ------------
  65. Ok, let's get the Legal nonsense out of the way first.
  66.  
  67.     The user of Echomail Tracker (EMT), by Blane M. Amy, agrees that
  68. Echomail Tracker and this documentation, are provided  as is  without
  69. any warranty, expressed or  implied,  including  but  not  limited to
  70. fitness for a particular purpose.  Blane M. Amy specifically disclaims
  71. all warranties. In no event shall the user hold the the author liable
  72. for any loss of profit or any other commercial damage, including but not
  73. limited to special, incidental, consequential, or other damages
  74. resulting from the use of this product.  Your use of Echomail Tracker
  75. constitutes acceptance of this limited warranty.
  76.  
  77.     EchoMail Tracker is not placed  in the Public Domain.   The copyright
  78. is retained and the software is provided on licence.
  79.  
  80.  
  81. Registration
  82. ------------
  83.     If you use EMT for more than a 30 day trial period, or you just plain
  84. like EMT and will continue to use it, please register EMT.
  85.  
  86.     Send $5.00 (Check or Money Order, NO CASH please) to:
  87.             Blane M. Amy
  88.             Rt.2 Box 471
  89.             Newberry, Fl.
  90.                    32669
  91.  
  92.     You probably spend more than $5.00 a day running mail, so please
  93. register EMT.  Besides, I need the money.
  94.  
  95.     The following people are exempt from paying a registration fee for
  96. allowing me the use of their software without a fee.  I found it and still
  97. use it.
  98.  
  99. Author             Software
  100. -----------        --------
  101. Bob Camp           Logtime.
  102. Mark Shasby        MSGT.
  103. Ken Thompson       Fixbbs, PUTID, Readarc.
  104. Stephen De Plater  Change Password, Genhist.
  105. Steve Thompson     Sedit, Daytime, CHKACC.
  106. John Delle-Torre   GTPWGEN, SayGday (No longer using with GT 16.00).
  107. B.J.Guillot        BGTOP, BGPCK
  108.  
  109.  
  110. Files with v1.10
  111. --------------------
  112.     With this release, EMT and its associated files should be in a file
  113. named EMT110.ZIP, and there should only be two files contained in this
  114. ZIP file:  EMT.EXE and EMT.DOC.  Any deviation from this and the
  115. possiblity exists that someone took it upon themselves to rename the ZIP
  116. file or add stuff.  Please disgard this package if the above is not
  117. true.  
  118.  
  119.  
  120.                                      -1-
  121.  
  122.  
  123.  
  124.  
  125. Purpose
  126. -------
  127.     The purpose of Echomail Tracker is to track slow echos, and/or
  128. problem echos.  A Daily report will be generated showing what echos have
  129. not come in, how many days since the echo has been recieved, and other
  130. associated data.
  131.     As an aside, Echomail Tracker will inform you of problems with your
  132. routing.bbs file such as:
  133.         1- Duplicate instructions in your Routing Instructions,
  134.            indicating two sources for an echo.
  135.         2- Ensure there are entries in the Message Distribution Section for
  136.            all Routing Instructions.
  137.         3- Duplicate instructions in your Message Distribution section.
  138.         4- Ensure there are entries in the Routing Instructions for all
  139.            Message Distribution entries.
  140.         5- Echos listed in your ROUTING.BBS that are shown as Retired.
  141.         6- Echos listed in your ROUTING.BBS that are shown as Renumbered.
  142.  
  143. Usage
  144. -----
  145.     EMT can be run anytime, anywhere, as many times as you want to run
  146. it, and it takes only about a minute to run (On my 10 mHz XT, with a 225
  147. echos, initialization takes just over 1 minute). The only effect you can
  148. have as of this release, is reguarding the number of days since an echo
  149. has come in, in the EMT.BBS report (See /D: option in command line options
  150. section).  Of course, when errors are detected in your ROUTING.BBS file,
  151. EMT will be very helpful.
  152.     I suggest running EMT after your normal daily mail run, and any
  153. other time you would possibly get new mail (GTCrash.bat, Crash.bat,
  154. etc...) for most recent information.  Also, you might want to run it anytime
  155. changes are made to your routing.bbs to detect errors.
  156.     To be clear, EMT will ONLY check to make sure that echo entries found in
  157. the Routing Instructions and Message Distribution have corresponding entries.
  158. Further format checking is beyond the capability of EMT (At least as of
  159. this release).
  160.  
  161.     EMT will create the following files when run:
  162.  
  163.        EMT.DAT - Located in your GTPATH directory, always!
  164.                  File created for storage of information.  If this file
  165.                  is accidentally deleted, no great harm is done.  This
  166.                  file will be regenerated (EMT will run slightly slower
  167.                  when intializing this file).  The only damage will be
  168.                  the loss of accumulated days since the echo has come
  169.                  in.  Only the current month will be represented when
  170.                  initializing this file.  (Of course you can always copy
  171.                  several months worth of gbag.log's into one gbag.log
  172.                  and run EMT.  In testing I placed 6 months of logs into
  173.                  one file (of course it took a little longer).  Beware
  174.                  though, that if you just ordered an echo, and it shows
  175.                  up that it has not come in for 172 days, it is not
  176.                  EMT's fault <grin>.)
  177.  
  178.  
  179.  
  180.                                      -2-
  181.  
  182.  
  183.  
  184.  
  185.        EMT.BBS - Located in your BBS directory (Check /B: option below)
  186.                  as defined in your GT configuration.
  187.                  The report file created with all the information you
  188.                  need to keep track of echomail.  This file is
  189.                  re-created each time you run EMT.
  190.                  A typical report will look like this  (excerpt):
  191.  
  192.    EchoMail Tracker                              Date: 7-20-1990   Time: 06:56
  193.                    Echos that have not been received.
  194. No.                                      Last
  195. Days Echo ID  Description                Day  Source  Sponsor          Net/Node
  196. ===============================================================================
  197.   3 E00/024 Ham Radio                    1292 033/007 Dave Mccrory      033/007
  198.   1 E00/023 Adventures In Travel         1291 033/007 Bob Camp          006/013
  199.  19 E00/065 Antique Electronics - Tubes  None 044/002 William Warren    077/001
  200.  19 E01/450 The Nintendo/Sega Game Conf  REN  079/003 Gene Newcomb      044/003
  201.  19 E10/090 Echo W/O PC Pursuit          RET  033/007 Bob Camp          006/013
  202.  19 E10/110 Paranormal & Fringe Science  DOWN 015/002 Terry Mcfalls     010/006
  203.  
  204.         Of 187 total echos, 104 echos were NOT received today.
  205.                 55.6% of the echos were not received.
  206.  
  207.                 Check file EMTERR.LOG for errors found!
  208.  
  209.     Hopefully, the headings are self-explanitory.  However, a few comments.
  210.     The first column is the number of days it has been since the echo has been
  211. received by you, not the number of echo days it has been (Check /D:
  212. option in command line options).
  213.     The Last Day column is the last echo date of the echo received,
  214. which will not necessarily correspond to the first column (notice lines
  215. 1 and 2 of the report).
  216.     The Last Day column could possibly have four other designations
  217. besides the last echo date received.
  218.         None - You have yet to receive this echo (or, in the case of
  219.                initialization or loosing the EMT.DAT file, you have yet
  220.                to receive the echo in the current month).
  221.         RET  - The echo has been listed as retired.  Probably time to
  222.                delete this echo from your ROUTING.BBS (And be curteous,
  223.                send your .gq and inform your source of this possibility).
  224.         REN  - This echo has for one reason or another been given a new
  225.                echo designation number.  Same comments as RET.
  226.         DOWN - The sponsor of this echo is listed as being down for one
  227.                reason or another.
  228.     The Source is the Net/Node you have listed as your mail forwarder in
  229. the Routing Instructions with the ACCEPT statement.  This might not
  230. necessarily correspond to your actual source if you get the echo from
  231. one Net/Node and forward the B-bags of the echo to a different Net/Node.
  232.     And, of course, the Net/Node column is the Net/Node of the listed
  233. sponsor.
  234.     The last 3 lines of report simply inform you of how many echos you
  235. have received and a percentage received, along with a notice if any
  236. errors were detected.
  237.  
  238.  
  239.  
  240.                                      -3-
  241.  
  242.  
  243.  
  244.  
  245.        EMTERR.LOG - Located in your GT LOG directory, Always (at least
  246.                     for the moment)!, (Oh no, not another log), as
  247.                     defined in your GT configuration.
  248.                     This file will be created only when any mistakes are
  249.                     detected.
  250.                     I hope the log entries are self explanatory.  At the
  251.                     moment, these are all the entries that are possible:
  252.  
  253. *******************************************************************************
  254. EMT Error Report                                Date: 7-20-1990    Time: 06:56
  255. *******************************************************************************
  256. Routing Instruction Errors:
  257.     Duplications
  258.         Echo    Source 1  Source 2
  259.         E02/102 046/000   079/003
  260.         E02/103 046/000   079/003
  261.     Echos in Routing Instructions not in Message Distribution
  262.         E01/450
  263.         E01/452
  264. Message Distribution Errors:
  265.     Duplications:
  266.         E00/001
  267.         E00/002
  268.     Echos in Message Distribution not in Routing Instructions
  269.         E01/012
  270. Echo Listing Errors:
  271.     Echos Listed as RETIRED still listed in Routing:
  272.         E02/250
  273.         E10/090
  274.     Echos Listed as RENUMBERED still listed in Routing:
  275.         E01/450 RENUMBERED to E01/657
  276.         E01/452 RENUMBERED to E00/090
  277. F File Errors:
  278.         Garbage F Files in MAILIN Directory
  279.                 F1274104.E10
  280.                 F1310100.E00
  281.                 F1327600.E01
  282.                 F1445501.Q14  (Just what are these 'Q'files anyway?)
  283.                 F1461014.E06
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.                                      -4-
  301.  
  302.  
  303.   More Notes:
  304.   -----------
  305.     File Inclusion is supported starting with version 1.10.  This is
  306. limited however.  If your main routing file is ROUTING.BBS, then you may
  307. have one of two statements in this file.  The '$' must be the first
  308. character on a line and must be in the first row.
  309. Valid Examples:
  310.  
  311. $ROUT1.RTE
  312. $ ROUT1.RTE   (Does not matter if there are spaces or not, or how many
  313.                spaces, although the example in the netmail docs does show
  314.                a space)
  315.  
  316. $C:\ROUTFILE\ROUT2.BBS
  317. $ C:\ROUTFILE\ROUT2.RTE
  318.  
  319.     The limitation with the file inclusion is that the second file, in the
  320. above examples, ROUT1.RTE, cannot also have another file inclusion.  EMT
  321. not recognize nested file inclusion.
  322.  
  323.     While EMT is running, several comments could possibly be seen.  All
  324. errors noted while EMT is running will be logged in the file EMTERR.LOG
  325. and a notation made in the EMT.BBS file that errors were found.
  326.  
  327.     The GTPATH must be set in your environment using the SET command in
  328. DOS or EMT will terminate.
  329.     Also, the following files must be located in your GTPATH directory,
  330. or EMT will terminate:
  331.         1-ROUTING.BBS (See /R:, /I:, and /M: options below)
  332.         2-ECHOLIST.BBS
  333.         3-GBAG.LOG
  334.  
  335. NOTE: The Gbag.log is where EMT gets its much of its information from.
  336. This was done because the log is there as a useful tool and provides lots
  337. of useful information.  Using the Gbag.log is much more useful than just
  338. using the control files the netmail suite produces.
  339.  
  340.     In the netmail 2.00 and above, you must not be using the /NL on Mbagger
  341. and Mdist command lines to suppress Gbag logging.  Also, you cannot use the
  342. /V option for verbose logging on the Mdist command line. The default mode is
  343. normal Gbag logging which is what is required to use EMT.
  344.  
  345.     If your using netmail programs prior to v2.00, I can't help you.
  346. I cannot remember the command line swithes to force Gbag loging, or if the
  347. Gbag logging was the same format (Noone should be using anything prior
  348. to netmail 2.00, At least I hope not, but it is not unexpected).
  349.  
  350.     I have no idea where else the files could be located, even in a
  351. network environment.  (Someone will correct me if I am wrong).
  352.     EMT does not recognize networking with this release.
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.                                      -5-
  361.  
  362.  
  363.     One last important note.  All of your routing instructions must be
  364. in one file.  The same must be true for the message distribution section.
  365. For instance, your routing instructions might all be in a file called
  366. ROUTE.RTE, and your message distribution section in a file called
  367. MESSAGE.RTE.  However, the sections can NOT be split between one or more
  368. files.  This is related to only the echo entries, not the netmail
  369. directives.
  370.  
  371. Command Line Options
  372. --------------------
  373.     There are only five command line parameters that can be used.
  374. Notice the colon after each one.  The colon MUST be there if shown, or
  375. the command line option will not be recognized.  Oh, one last note.
  376. Although the below commands and examples are in upper case, case does
  377. not matter. Lower case is fine to use, or if you really like to be strange,
  378. like myself, cases can be mixed, it simply is not a factor.
  379.  
  380.     /B:     The option to have the EMT.BBS file made as a bulletin.
  381.             Without this command line, EMT wil make the EMT.bbs file and
  382.             place it in your GTPATH directory.
  383.             Example: /B:5
  384.  
  385.             This would make the EMT.BBS file, bulletin number five in
  386.             your default directory.
  387.  
  388.     /D:     Command line switch for the EMT.BBS file.
  389.             Below are typical entries in the EMT.BBS.  Using the /D:
  390.             switch, you can control what is reported as far as how many
  391.             days since you recieved a particular echo.
  392.             It has been 3 days since E00/024 has been received, 1 day
  393.             for E00/023, and 19 days for E00/065.
  394.  
  395.   3 E00/024 Ham Radio                    1292 033/007 Dave Mccrory      033/007
  396.   1 E00/023 Adventures In Travel         1291 033/007 Bob Camp          006/013
  397.  19 E00/065 Antique Electronics - Tubes  None 044/002 William Warren    077/001
  398.  
  399. Using the command line switch, /D:3, would eliminate E00/023 from the report
  400. and all others not received in 2 or less days.  This will give you some form
  401. of control in case you don't care if echos show up for less than a certain
  402. amount of time.  The Default is 1 day.
  403.  
  404.     /I:     Informs EMT of an alternate file containing ALL of the Routing
  405.             Instructions.  The default file is ROUTING.BBS.
  406.             Example: /I:ROUTE.RTE
  407.  
  408.     /M:     Informs EMT of an alternate file containing ALL of the Message
  409.             Distribution Section.  The default file is ROUTING.BBS.
  410.             Example: /M:MESSAGE.RTE
  411.  
  412.     /R:     Informs EMT of an alternate name for your ROUTING.BBS file.
  413.             The default file is ROUTING.BBS.
  414.             Example:  /R:ROUTE1.BBS
  415.  
  416.  
  417.  
  418.  
  419.  
  420.                                      -6-
  421.  
  422. General Comments
  423. ----------------
  424.     EMT was written entirely in Turbo C, using only the standard libray
  425. funtions that come in the Turbo C library.
  426.  
  427. Future Revisions
  428. ----------------
  429.     I have planned to add the capability of sending the EMT.BBS to
  430. whatever message area the SYSOP would like so as not to have to look at
  431. a file everytime.
  432.     Checking for receipt of duplicate echos from more than one source is
  433. also on the list.  This is the main reason I chose the Gbag.log as the
  434. MAIN source of info.  Just checking the control files could not give you
  435. this info, at least to the best of my knowledge.
  436.     Somehow, someway, I am going to include support for people who use
  437. the verbose listing in the Gbag.log.  At the moment, any echos listed in
  438. the Gbag.log under the verbose listing will not be recognized.  With
  439. EMT, you shouldn't have to use this option anymore.
  440.     I also envision adding the capability to have EMT automatically send
  441. netmail to your source for the echo and the sponsor, to inform them of
  442. problems, and to possibly enter a message directly in the echo to test
  443. routing.  Actually, when first planned, these features were number one
  444. on the list.  I strayed slightly <grin>.
  445.     There are only about a bizillion things you could do wrong in the
  446. ROUTING.BBS file, and I am sure that all of us at one time or another,
  447. have found one or two.  More checking would be added to detect other
  448. mistakes, any mistakes, I do lots of typos myself.
  449.  
  450. Final Comments
  451. --------------
  452. I can be contacted at:
  453.        GT Net/Node:                              087/001
  454.        Voice Number:                             (904)472-6072
  455.        BBS Number (The Philosopher's Corner):    (904)472-1860
  456.        Mailing Address:                          Rt.2  Box 471
  457.                                                  Newberry, Fla
  458.                                                          32669
  459.  
  460.     Please direct any comments, questions, suggestions, winning lottery
  461. tickets, swiss bank accounts, etc., to one of the above.
  462.  
  463. Enjoy!
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.                                      -7-
  481.  
  482.